LotusScript Doc

LotusScript library: LSALibCorrespondence

Options
Public
Declare

Uses
LSALibBasic

Global variables
Private Const PAI_DEFAULT_DELIMITER = "#"
Private Const PAI_FORBIDDEN_CHARS_0 = "|"
Private Const PAI_FORBIDDEN_CHARS_1 = "#"
Private Const PAI_FORBIDDEN_CHARS_2 = "~"
Private Const PAI_DEFAULT_KEY_NAME = "Key"
Private Const PAI_DEFAULT_CAREOF_NAME = "CareOfName"
Private Const PAI_DEFAULT_BUILDING_NAME = "Building"
Private Const PAI_DEFAULT_ROOM_NAME = "Room"
Private Const PAI_DEFAULT_STREET_NAME = "Street"
Private Const PAI_DEFAULT_STREET_NO_NAME = "StreetNo"
Private Const PAI_DEFAULT_POSTBOX_NAME = "Postbox"
Private Const PAI_DEFAULT_ZIP_NAME = "Zip"
Private Const PAI_DEFAULT_CITY_NAME = "City"
Private Const PAI_DEFAULT_COUNTRY_NAME = "Country"
Private Const PAI_DEFAULT_STATE_NAME = "State"
Private Const PAI_DEFAULT_DISPLAY_FORMAT = "<Key>[<City>;: <City>[<Street>; <Street> <StreetNo>];[<Street>;: <Street> <StreetNo>]]"
Private Const POA_DEFAULT_FORM_NAME = "LSAPostalAddress"
Private Const NAL_DEFAULT_LIST_DELIMITER = "#"
Public ErrSerialData = Integer
Public ErrTxtSerialData = String
Public ErrWrongFormat = Integer
Public ErrTxtWrongFormat = String
Public ErrQueryNotFound = Integer
Public ErrTxtQueryNotFound = String
Private Const PAS_DEFAULT_ITEM_DELIMITER = "~"
Private Const PAS_DEFAULT_LIST_DELIMITER = "#"
Private Const PAS_FORBIDDEN_CHAR_0 = "|"
Private Const PAS_FORBIDDEN_CHAR_1 = "#"
Private Const PAS_FORBIDDEN_CHAR_2 = "~"

Types
Public ListItem
Public Node

Container for the class LSAPostalAddresseS

Author:
LPS EMEA
Version:
1.2.6, 04.AUG.2000

Class Summary
Public LSANamedList
Public LSAPostalAddress
Public LSAPostalAddresseS
Public LSAPostalAddressItem


Method Summary
Sub castToList (vList As Variant, copyList List As String)
Sub CreateDataList (data As String, DataList List As Node)
Function CreateMapping (AttributeList List As String, DataList List As Node) As Variant
Function DisplayChildren (DataList List As Node, Pos As String) As String
Function DisplayList (DataList List As Node) As String
Function GetDelimiterString (SerialData As String, Delimiter As String) As Integer
Function GetPosChildren (Value As Variant, DataList List As Node, Pos As String) As String
Function GetPosition (Value As Variant, DataList List As Node) As String
Function GetValue (Query As String, DataList List As Node) As Variant
Sub Initialize ()
Function IsNonDelimiterText (TextToProof As String, Delimiter As String) As Integer
Function IsSerialData (SerialData As String) As Integer
Sub ReplaceSubstring (data As String, substring As String, replacement As String)
Function SplitDelimiter (Delimiter As String) As Variant
Sub throwDelimiterError (txt As String, arr As Variant)

Method Detail

throwDelimiterError

Public Sub throwDelimiterError(txt As String,arr As Variant)
Throws an Error of Type ErrDelimiterInField. This is a helper function

Parameters:
txtStringvalue of the attribute where the not allowed characters are used
arrVariantArray of not allowed characters
Errors:
ErrDelimiterInField
Summmary Top

Initialize

Public Sub Initialize
Summmary Top

GetValue

Public Function GetValue(Query As String,DataList List As Node) As Variant
Summmary Top

GetPosition

Public Function GetPosition(Value As Variant,DataList List As Node) As String
Summmary Top

GetPosChildren

Public Function GetPosChildren(Value As Variant,DataList List As Node,Pos As String) As String
Summmary Top

DisplayList

Public Function DisplayList(DataList List As Node) As String
Summmary Top

DisplayChildren

Public Function DisplayChildren(DataList List As Node,Pos As String) As String
Summmary Top

CreateMapping

Public Function CreateMapping(AttributeList List As String,DataList List As Node) As Variant
Summmary Top

CreateDataList

Public Sub CreateDataList(data As String,DataList List As Node)
Summmary Top

ReplaceSubstring

Private Sub ReplaceSubstring(data As String,substring As String,replacement As String)
Summmary Top

SplitDelimiter

Public Function SplitDelimiter(Delimiter As String) As Variant
Summmary Top

GetDelimiterString

Public Function GetDelimiterString(SerialData As String,Delimiter As String) As Integer
Summmary Top

IsSerialData

Public Function IsSerialData(SerialData As String) As Integer
Summmary Top

IsNonDelimiterText

Public Function IsNonDelimiterText(TextToProof As String,Delimiter As String) As Integer
Summmary Top

castToList

Public Sub castToList(vList As Variant,copyList List As String)
Casts a Variant containing a list of string to a list of string which has to be passed as parameter. The reason for that is that the datatype "List as String" can be returned by a property or a function.
!!!! Attention !!!! Maybe it is a good idea to migrate this function to LSALibFct.

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:34 AM